Get information about a ShipmentTimelineEvent

SecurityAuthToken

Request

path Parameters

shipmentId required	string <uuid> The id of the shipment
shipmentTimelineEventId required	string <uuid>

Responses

200

Successfully returned a ShipmentTimelineEvent

Response Schema: application/json

	object (User)
created_at	string or null <date-time>
	object (ShipmentTimelineEventCustomData) Custom data for ShipmentTimelineEvents
description	string or null
event_sub_type	string or null Enum: "AT_DELIVERY" "AT_LOCATION" "AT_PICKUP" "AT_STOP" "CANCELED" "DELAYED" "DELIVERED" "DELIVERED_EXCEPTION" "DELIVERY" "DELIVERY_APPOINTMENT" "DELIVERY_MISSED" "DEPARTED" "DEPARTED_STOP" "DEPARTURE" "DEPARTURE_MISSED" "DISPATCHED" "EN_ROUTE" "EXCEPTION" "HELD" "IN_TRANSIT" "INFO" "INTERLINE" "INTERLINE_DELIVERED" "INTERLINE_MISSED" "OUT_FOR_DELIVERY" "PICKED_UP" "PICKUP" "PICKUP_MISSED" "STOP_CANCELLED" "STOP_COMPLETED"
event_type required	string Enum: "AT_DELIVERY" "AT_PICKUP" "BOOKED" "CANCELLED" "CARRIER_MATCHED" "DELIVERED" "DETAILS_CHANGED" "DISPATCHED" "DRIVER_ASSIGNED" "ETA_CHANGED" "INFO" "LOCATION_UPDATED" "PICKED_UP" "TRACK_RECEIVED" "STOP_COMPLETED" "STOP_EVENT"
id	string or null <uuid>
occurred_at	string or null <date-time>
source	string or null
updated_at	string or null <date-time>

default

Default error response

get/shipments/{shipmentId}/timeline-events/{shipmentTimelineEventId}/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"actor": {"avatar": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"completed_onboarding": true,
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"default_shipment_tags": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"email": "string",
"first_name": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_active": true,
"is_quoting_limited_user": true,
"last_login": "2019-08-24T14:15:22Z",
"last_name": "string",
"password": "string",
"permissions": ["string"
],
"phone_number": "string",
"subscribed_to_loadboard": true,
"timezone": "string",
"updated_at": "2019-08-24T14:15:22Z",
"verified_email": true
},
"created_at": "2019-08-24T14:15:22Z",
"custom_data": {"property1": null,
"property2": null
},
"description": "string",
"event_sub_type": "AT_DELIVERY",
"event_type": "AT_DELIVERY",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"occurred_at": "2019-08-24T14:15:22Z",
"source": "string",
"updated_at": "2019-08-24T14:15:22Z"
}